List Box Item Container for 2D List Box nodes. More...

#include <kanzi/ui/node/list_box_item_container.hpp>

Inheritance diagram for kanzi::ListBoxItemContainer2D:

Static Public Member Functions
static ListBoxItemContainer2DSharedPtr	create (Domain *domain, string_view name)
	Creates a list box item container node.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::ClickConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::ListBoxItemContainer
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Protected Member Functions
	ListBoxItemContainer2D (Domain *domain, string_view name)
	Constructor.

Protected Member Functions inherited from kanzi::ListBoxItemContainerImpl< ContentLayout2D, ListBoxItemContainer2D, ContentLayout2D >
void	initialize ()

	ListBoxItemContainerImpl (Domain *domain, string_view name)

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override

Protected Member Functions inherited from kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >
	ClickConceptImpl (Domain *domain, string_view name)
	Constructor.

void	configureDoubleClick ()
	Configures a MultiClickManipulator for an ClickConcept-derived class based on the value of the DoubleClickEnabledProperty:

void	onAttached () override
	Overrides TBaseClass::onAttached().

void	onClicked (ClickManipulator::ClickMessageArguments &messageArguments)
	Handles click event.

void	onDetached () override
	Overrides TBaseClass::onDetached().

void	onMultiClicked (MultiClickManipulator::MultiClickMessageArguments &messageArguments)
	Handles multi-click event.

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Overrides TBaseClass::onNodePropertyChanged().

Protected Attributes
ClassPropertyDefaultValue< bool >	m_clipChildrenClassDefaultValue
	Class default value for ClipChildrenProperty.

Protected Attributes inherited from kanzi::ListBoxItemContainerImpl< ContentLayout2D, ListBoxItemContainer2D, ContentLayout2D >
BindingRuntimeHandle	m_focusOrderBinding

ItemBaseTypeSharedPtr	m_item

Protected Attributes inherited from kanzi::ClickConcept
ClickManipulatorSharedPtr	m_clickManipulator
	The ClickManipulator.

MultiClickManipulatorSharedPtr	m_multiClickManipulator
	Multi-Click manipulator.

Additional Inherited Members
Public Types inherited from kanzi::ListBoxItemContainerImpl< ContentLayout2D, ListBoxItemContainer2D, ContentLayout2D >
using	ItemBaseType

using	ItemBaseTypeSharedPtr

using	ItemLayoutSharedPtr

Public Member Functions inherited from kanzi::ListBoxItemContainerImpl< ContentLayout2D, ListBoxItemContainer2D, ContentLayout2D >
void	attachItem (ItemBaseTypeSharedPtr item)
	Attaches a List Box item to the List Box Item Container.

void	detachItem ()
	Detaches current List Box item from the List Box Item Container.

auto	getItem () const
	Returns the List Box item that is attached to the List Box Item Container.

optional< size_t >	getItemIndex () const
	Returns the index of the item held by the List Box Item Container.

optional< size_t >	getPresenterIndex () const
	Returns a List Box Presenter item index.

bool	isSelected () const
	Returns the value of SelectedProperty.

void	setPresenterIndex (optional< size_t > itemIndex)
	Sets the List Box Presenter item index.

void	setSelected (bool value)
	Sets the value of SelectedProperty.

Public Member Functions inherited from kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >
bool	isDoubleClickEnabled () const
	Gets the value of DoubleClickEnabledProperty.

void	setDoubleClickEnabled (bool value)
	Sets the value of DoubleClickEnabledProperty.

Static Public Attributes inherited from kanzi::ClickConcept
static PropertyType< bool >	DoubleClickEnabledProperty
	Enables the double-click gesture for a node.

Static Public Attributes inherited from kanzi::ListBoxItemContainer
static PropertyType< int >	ItemIndexProperty
	Reports the index of the item held by the List Box Item Container.

static PropertyType< bool >	SelectedProperty
	Indicates whether a List Box item held by this List Box Item Container is selected.

Static Protected Member Functions inherited from kanzi::ListBoxItemContainerImpl< ContentLayout2D, ListBoxItemContainer2D, ContentLayout2D >
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Detailed Description

List Box Item Container for 2D List Box nodes.

Wrapper component for storing item object nodes.

Constructor & Destructor Documentation

◆ ListBoxItemContainer2D()

kanzi::ListBoxItemContainer2D::ListBoxItemContainer2D	(	Domain *	domain,
		string_view	name )

explicitprotected

Constructor.

Parameters

domain	The UI domain the new node belongs to.
name	The name of the node.

Member Function Documentation

◆ create()

static ListBoxItemContainer2DSharedPtr kanzi::ListBoxItemContainer2D::create	(	Domain *	domain,
		string_view	name )

static

Creates a list box item container node.

Parameters

domain	The UI domain the new node belongs to.
name	Name of the node.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ListBoxItemContainer2D::makeEditorInfo ( )

static

Member Data Documentation

◆ m_clipChildrenClassDefaultValue

ClassPropertyDefaultValue<bool> kanzi::ListBoxItemContainer2D::m_clipChildrenClassDefaultValue

protected

Class default value for ClipChildrenProperty.

Required to override the class default value from ContentLayout2D.

The documentation for this class was generated from the following file:

kanzi/ui/node/list_box_item_container.hpp

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members